/*
 * Copyright (c) 2010 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.data.gdata.v2.model;

import com.google.api.client.util.Key;
import com.google.api.data.gdata.v2.model.Name.NameWithYomi;

/**
 * An organization, typically associated with a contact.
 * 
 * @since 2.2
 * @author Nicolas Garnier
 */
public class Organization {

  public static final String REL_WORK = "http://schemas.google.com/g/2005#work";
  /**
   * An organization that is not work. label can be used to indicate the actual
   * type.
   */
  public static final String REL_OTHER = "http://schemas.google.com/g/2005#other";

  /**
   * A simple string value used to name this organization. It allows UIs to
   * display a label such as "Work", "Volunteer", "Professional Society", etc.
   */
  @Key("@label")
  public String label;

  /** Specifies a department within the organization. */
  @Key("gd:orgDepartment")
  public String department;

  /** Description of a job within the organization. */
  @Key("gd:orgJobDescription")
  public String jobDescription;

  /** The name of the organization. */
  @Key("gd:orgName")
  public NameWithYomi name;

  /** Symbol of the organization. */
  @Key("gd:orgSymbol")
  public String symbol;

  /** The title of a person within the organization. */
  @Key("gd:orgTitle")
  public String title;

  /** Specifies the address as primary. Default value is false. */
  @Key("@primary")
  public Boolean primary;

  /**
   * A programmatic value that identifies the type of organization; see below
   * for details.
   */
  @Key("@rel")
  public String rel;

  /**
   * A place associated with the organization, e.g. office location.
   */
  @Key("gd:where")
  public Where where;
}
